﻿#region Copyright and License Notice
// Copyright (C)2010-2016 - Rob Levine and other contributors
// http://configgen.codeplex.com
// 
// This file is part of ConfigGen.
// 
// ConfigGen is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// ConfigGen is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License and 
// the GNU Lesser General Public License along with ConfigGen.  
// If not, see <http://www.gnu.org/licenses/>
#endregion

using System.IO;
using ConfigGen.Core.ConfigurationSettings;
using ConfigGen.Core.TemplateLoader;

namespace ConfigGen.Core
{
    /// <summary>
    /// Interface implemented by types responsible for writing generated configuration files.
    /// </summary>
    /// <typeparam name="TResults">Type of results class used by the implementing class to record config file generation results.</typeparam>
    public interface IOutputWriter<TResults> where TResults : OutputWriterResultsBase
    {
        /// <summary>
        /// Writes the file.
        /// </summary>
        /// <param name="machineConfiguration">The machine configuration.</param>
        /// <param name="generatedConfigStream">The generated config stream.</param>
        /// <param name="settings">The settings.</param>
        /// <param name="templatePreferences">The template preferences.</param>
        /// <returns></returns>
        TResults WriteFile(
            MachineConfigurationSettings machineConfiguration,
            Stream generatedConfigStream, 
            Preferences settings, 
            TemplatePreferences templatePreferences);
    }
}